Package com.netscape.certsrv.dbs
Class DBVirtualList<E extends IDBObj>
java.lang.Object
com.netscape.certsrv.dbs.DBVirtualList<E>
- Direct Known Subclasses:
LDAPVirtualList
@Deprecated(since="11.6.0",
forRemoval=true)
public class DBVirtualList<E extends IDBObj>
extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
A class represents a virtual list of search results.
-
Constructor Summary
ConstructorsConstructorDescriptionDeprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionint
Deprecated, for removal: This API element is subject to removal in a future version.getElementAt
(int index) Deprecated, for removal: This API element is subject to removal in a future version.Fetchs data of a single list item Recommend to call getSize() before getElementAt() or getElements() since you'd better check if the index is out of bound first.int
Deprecated, for removal: This API element is subject to removal in a future version.Gets the top of the buffergetJumpToElementAt
(int i) Deprecated, for removal: This API element is subject to removal in a future version.Retrieves and jumps to element in the given position.boolean
getPage
(int first) Deprecated, for removal: This API element is subject to removal in a future version.Get a page starting at "first" (although we may also fetch some preceding entries) Recommend to call getSize() before getElementAt() or getElements() since you'd better check if the index is out of bound first.boolean
Deprecated, for removal: This API element is subject to removal in a future version.Called by application to scroll the list with initial letters.int
Deprecated, for removal: This API element is subject to removal in a future version.Gets the virutal selected indexint
getSize()
Deprecated, for removal: This API element is subject to removal in a future version.Retrieves the size of this virtual list.int
Deprecated, for removal: This API element is subject to removal in a future version.int
Deprecated, for removal: This API element is subject to removal in a future version.Returns current index.void
processElements
(int startidx, int endidx, ElementProcessor<E> ep) Deprecated, for removal: This API element is subject to removal in a future version.Processes elements as soon as it arrives.void
setPageSize
(int size) Deprecated, for removal: This API element is subject to removal in a future version.Sets the paging size of this virtual list.void
setSortKey
(String sortKey) Deprecated, for removal: This API element is subject to removal in a future version.Sets the sort keyvoid
setSortKey
(String[] sortKeys) Deprecated, for removal: This API element is subject to removal in a future version.Sets the sort key
-
Constructor Details
-
DBVirtualList
public DBVirtualList()Deprecated, for removal: This API element is subject to removal in a future version.
-
-
Method Details
-
setPageSize
public void setPageSize(int size) Deprecated, for removal: This API element is subject to removal in a future version.Sets the paging size of this virtual list. The page size here is just a buffer size. A buffer is kept around that is three times as large as the number of visible entries. That way, you can scroll up/down several items(up to a page-full) without refetching entries from the directory.- Parameters:
size
- the page size
-
setSortKey
Deprecated, for removal: This API element is subject to removal in a future version.Sets the sort key- Parameters:
sortKey
- the attribute to sort by- Throws:
EBaseException
- failed to set
-
setSortKey
Deprecated, for removal: This API element is subject to removal in a future version.Sets the sort key- Parameters:
sortKeys
- the attributes to sort by- Throws:
EBaseException
- failed to set
-
getSize
public int getSize()Deprecated, for removal: This API element is subject to removal in a future version.Retrieves the size of this virtual list. Recommend to call getSize() before getElementAt() or getElements() since you'd better check if the index is out of bound first.- Returns:
- current size in list
-
getSizeBeforeJumpTo
public int getSizeBeforeJumpTo()Deprecated, for removal: This API element is subject to removal in a future version.Returns current index.- Returns:
- current index
-
getSizeAfterJumpTo
public int getSizeAfterJumpTo()Deprecated, for removal: This API element is subject to removal in a future version. -
getCurrentIndex
public int getCurrentIndex()Deprecated, for removal: This API element is subject to removal in a future version. -
getPage
public boolean getPage(int first) Deprecated, for removal: This API element is subject to removal in a future version.Get a page starting at "first" (although we may also fetch some preceding entries) Recommend to call getSize() before getElementAt() or getElements() since you'd better check if the index is out of bound first.- Parameters:
first
- the index of the first entry of the page you want to fetch
-
getPage
Deprecated, for removal: This API element is subject to removal in a future version.Called by application to scroll the list with initial letters. Consider text to be an initial substring of the attribute of the primary sorting key(the first one specified in the sort key array) of an entry. If no entries match, the one just before(or after, if none before) will be returned as mSelectedIndex- Parameters:
text
- the prefix of the first entry of the page you want to fetch
-
getElementAt
Deprecated, for removal: This API element is subject to removal in a future version.Fetchs data of a single list item Recommend to call getSize() before getElementAt() or getElements() since you'd better check if the index is out of bound first. If the index is out of range of the virtual list, an exception will be thrown and return null- Parameters:
index
- the index of the element to fetch
-
getJumpToElementAt
Deprecated, for removal: This API element is subject to removal in a future version.Retrieves and jumps to element in the given position.- Parameters:
i
- position- Returns:
- object
-
processElements
Deprecated, for removal: This API element is subject to removal in a future version.Processes elements as soon as it arrives. It is more memory-efficient.- Parameters:
startidx
- starting indexendidx
- ending indexep
- object to call- Throws:
EBaseException
- failed to process elements
-
getSelectedIndex
public int getSelectedIndex()Deprecated, for removal: This API element is subject to removal in a future version.Gets the virutal selected index- Returns:
- selected index
-
getFirstIndex
public int getFirstIndex()Deprecated, for removal: This API element is subject to removal in a future version.Gets the top of the buffer- Returns:
- first index
-
DBPagedSearch